Skip to content

feat(#2994): add visual mode operations: copy, cut, delete, trash, toggle bookmark#3268

Merged
alex-courtis merged 1 commit intonvim-tree:masterfrom
v3ceban:master
Mar 13, 2026
Merged

feat(#2994): add visual mode operations: copy, cut, delete, trash, toggle bookmark#3268
alex-courtis merged 1 commit intonvim-tree:masterfrom
v3ceban:master

Conversation

@v3ceban
Copy link
Contributor

@v3ceban v3ceban commented Feb 15, 2026

Add visual selection operations

Closes #2994
See also: #2993

Summary

Adds visual selection support to nvim-tree. Users can visually select a range of nodes (charwise, linewise, or blockwise) and operate on them with a single keypress, matching standard Vim visual mode behavior.

Supported operations:

  • Toggle bookmark (m)
  • Copy (c)
  • Cut (x)
  • Delete (d and Del) -- single confirmation prompt for the entire selection
  • Trash (D) -- single confirmation prompt for the entire selection

Design

Existing API functions (api.fs.copy.node, api.fs.cut, api.fs.remove, api.fs.trash, api.marks.toggle) are now mode-dependent -- no new API functions are added. When called in visual mode they operate on the selected range; in normal mode they behave exactly as before.

Default keymaps use { "n", "x" } mode tables so the same key works in both modes. The g? help window shows a mode column (e.g. n, nx) for each mapping, with mode characters sorted for deterministic display.

  • Visual range detection uses vim.fn.line("v") / vim.fn.line(".") while still in visual mode, avoiding <Esc> + '</'> marks. All visual and select modes are supported.
  • Explorer:get_nodes_in_range() reuses the existing get_nodes_by_line() infrastructure.
  • Node class check for single-vs-array dispatch: type(node_or_nodes) == "table" and node_or_nodes.is and node_or_nodes:is(Node) ensures correct handling when passed a table that is not a class instance.
  • Descendant filtering (utils.filter_descendant_nodes): when a directory and its children are both selected, only the directory is operated on. Walks the full .parent chain to handle group_empty grouped nodes and collapsed directories.
  • Single prompt for delete/trash rather than per-node confirmation. Respects ui.confirm.default_yes config; prompt construction extracted to utils.confirm_prompt().
  • Batch conflict resolution for paste: non-conflicting items are pasted immediately; conflicting items are resolved in a single prompt with rename-suffix, overwrite-all, or skip-all options.
  • Clipboard:finish_paste() calls reload_explorer() to refresh the tree after paste. This ensures the tree reflects filesystem changes regardless of watcher state, and clears clipboard highlights even when all conflicts are skipped.
  • Visual mode is exited synchronously (nvim_feedkeys with "nx" flags) before any operation executes.

Files Changed

  • utils.lua -- filter_descendant_nodes(), confirm_prompt(), is_visual_mode(), exit_visual_mode(), get_visual_nodes()
  • api/impl/post.lua -- wrap_node_or_visual() dispatcher for mode-dependent API functions
  • explorer/init.lua -- Explorer:get_nodes_in_range(start_line, end_line)
  • actions/fs/remove-file.lua -- remove_one() / remove_many() split, Node class check dispatch
  • actions/fs/trash.lua -- trash_one() / trash_many() split, Node class check dispatch
  • actions/fs/clipboard.lua -- bulk_clipboard(), resolve_conflicts(), finish_paste(), Node class check dispatch in copy() / cut()
  • marks/init.lua -- toggle_one() extracted, toggle() handles single node or array with Node class check
  • keymap.lua -- { "n", "x" } mode tables for visual-capable keymaps
  • help.lua -- mode column display, mode merging and sorting for duplicate lhs+desc entries
  • scripts/help-defaults.sh -- parse both "n" and { "n", "x" } mode forms for help doc generation
  • _meta/api/fs.lua, _meta/api/marks.lua -- updated docs with "In visual mode..." notes
  • api.lua -- mode-dependent behavior note
  • doc/nvim-tree-lua.txt -- regenerated help with mode column

Copilot AI review requested due to automatic review settings February 15, 2026 05:16
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds first-class visual selection support to nvim-tree, allowing users to use V + motion to select a range of nodes and operate on them with a single keypress. The implementation includes support for toggle bookmark, copy, cut, delete, and trash operations on visually selected nodes.

Changes:

  • Added visual mode keybindings (m, c, x, d, D) for operating on visual selections
  • Implemented Explorer:get_nodes_in_range() to retrieve all nodes within a visual selection
  • Created bulk operation functions bulk_delete_nodes() and bulk_trash_nodes() with single confirmation prompts
  • Added descendant filtering to prevent errors when both a directory and its children are selected
  • Updated help system to display visual mode keymaps with [v] prefix

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
lua/nvim-tree/marks/init.lua Adds filter_descendant_nodes, bulk_delete_nodes, and bulk_trash_nodes functions for visual selection operations
lua/nvim-tree/explorer/init.lua Implements get_nodes_in_range method to retrieve nodes within a line range
lua/nvim-tree/api/impl/post.lua Adds wrap_visual_range and wrap_visual_bulk wrapper functions and wires up visual API endpoints
lua/nvim-tree/keymap.lua Defines default visual mode keymaps (x mode) for visual operations
lua/nvim-tree/help.lua Prefixes visual mode keymaps with [v] in help window
lua/nvim-tree/_meta/api/marks.lua Adds type annotation for toggle_visual function
lua/nvim-tree/_meta/api/fs.lua Adds type annotations for visual, cut_visual, remove_visual, and trash_visual functions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@alex-courtis
Copy link
Member

I see many Copilot comments on this PR.

Was AI used to generate this code?

@v3ceban
Copy link
Contributor Author

v3ceban commented Feb 16, 2026

I see many Copilot comments on this PR.

Yeah, it's just the review thingy. Didn't even know it'd work in someone else's repo.

Was AI used to generate this code?

A bit. Initially, to find the right API functions in the nvim-tree codebase for the bindings that I left in #2994, and then for the automated review, obviously.

@alex-courtis
Copy link
Member

You can fix help generation by adding other mode handling to the script:

diff --git a/scripts/help-defaults.sh b/scripts/help-defaults.sh
index 11ffefe..609072f 100755
--- a/scripts/help-defaults.sh
+++ b/scripts/help-defaults.sh
@@ -45,7 +45,7 @@ sed -i -e "/${begin}/,/${end}/{ /${begin}/{p; r /tmp/ON_ATTACH_DEFAULT.lua

 # help human
 echo > /tmp/ON_ATTACH_DEFAULT.help
-sed -E "s/^ *vim.keymap.set\(\"n\", \"(.*)\",.*api(.*),.*opts\(\"(.*)\".*$/'\`\1\`' '\3' '|nvim_tree.api\2()|'/g
+sed -E "s/^ *vim.keymap.set\(\".\", \"(.*)\",.*api(.*),.*opts\(\"(.*)\".*$/'\`\1\`' '\3' '|nvim_tree.api\2()|'/g
 " /tmp/ON_ATTACH_DEFAULT.lua | while read -r line
 do
    eval "printf '%-17.17s %-26.26s %s\n' ${line}" >> /tmp/ON_ATTACH_DEFAULT.help

You can then commit the updated help as per https://github.com/nvim-tree/nvim-tree.lua/blob/master/CONTRIBUTING.md#help-documentation

@alex-courtis
Copy link
Member

Yeah, it's just the review thingy. Didn't even know it'd work in someone else's repo.

Please don't use automated reviews in the future.

I'll get to a review this week.

@Uanela
Copy link
Collaborator

Uanela commented Feb 18, 2026

This such a great feat, I was already looking forward to start working on this, I was just tired of jump from tree to oil and so on for some simple tasks.

@alex-courtis
Copy link
Member

alex-courtis commented Feb 20, 2026

I haven't had a chance to review the code, however cursory initial testing looks good. This is fantastic as it opens the door for future visual (and other) mode operations.

Looking at the new API like nvim_tree.api.fs.copy.visual(): do we actually need it?

Rather than adding new API, we could make the existing API context dependent: when vim.api.nvim_get_mode().mode == "v" or V or maybe x we do the visual copy otherwise we do "normal" node copy.

@alex-courtis
Copy link
Member

Disregard the CI that has not run; new test matricies have not yet filtered through.

@v3ceban
Copy link
Contributor Author

v3ceban commented Feb 20, 2026

I haven't had a chance to review the code, however cursory initial testing looks good. This is fantastic as it opens the door for future visual (and other) mode operations.

Thanks! And no worries - I’ve been quite busy myself - might not have a chance to jump on this again till tomorrow

Rather than adding new API, we could make the existing API context dependent: when vim.api.nvim_get_mode().mode == "v" or V or maybe x we do the visual copy otherwise we do "normal" node copy.

Yeah, this sounds good to me. No reason to duplicate the apis if existing ones are ok to extend. I was a bit cautious to not break any direct api usage accidentally with the new mode, but the risk is probably low here.

What should we do with mapping and help menu though? I assume having a separate entry for visual mode won’t make sense then.

I can extend the description of existing maps to mention visual mode operations.

Or, perhaps, we could even skip mentioning it in the description at all? At least to me this felt like a “natural” thing to try when I first attempted to delete multiple files. Mentioning it for every supported mapping may just add redundancy.


sry for typos - sent from my phone

@alex-courtis
Copy link
Member

Yeah, this sounds good to me. No reason to duplicate the apis if existing ones are ok to extend. I was a bit cautious to not break any direct api usage accidentally with the new mode, but the risk is probably low here.

Your caution is most gratefully appreciated.

For the mapping itself, we can set multiple modes (table) e.g.

  vim.keymap.set({"n","v"}, "c",              api.fs.copy.node,                   opts("Copy"))

What should we do with mapping and help menu though? I assume having a separate entry for visual mode won’t make sense then.

We could be lazy with the help screen and just add a mode column in the middle, something like nx or nv or nV

nvim-tree-quickstart-help could mirror this, as the first two columns are the same.

I can extend the description of existing maps to mention visual mode operations.

Or, perhaps, we could even skip mentioning it in the description at all? At least to me this felt like a “natural” thing to try when I first attempted to delete multiple files. Mentioning it for every supported mapping may just add redundancy.

That should be OK.

vim help already has nvim-tree-mappings-default and the users will see it in the help screen and nvim-tree-quickstart-help

We can add a catch all note to nvim-tree-api in the "Generally, functions accepting..." section to describe mode dependent behaviour of API that has modal mappings.

@v3ceban
Copy link
Contributor Author

v3ceban commented Feb 20, 2026

We could be lazy with the help screen and just add a mode column in the middle, something like nx or nv or nV

nvim-tree-quickstart-help could mirror this, as the first two columns are the same.

vim help already has nvim-tree-mappings-default and the users will see it in the help screen and nvim-tree-quickstart-help

We can add a catch all note to nvim-tree-api in the "Generally, functions accepting..." section to describe mode dependent behaviour of API that has modal mappings.

Ok, this sounds good to me! I’ll get to it whenever I have a chance (most likely in the next ~24 hours)

@alex-courtis
Copy link
Member

Cheers. No hurry at all.

@v3ceban v3ceban force-pushed the master branch 7 times, most recently from 698610b to ba869c9 Compare February 20, 2026 22:00
@v3ceban
Copy link
Contributor Author

v3ceban commented Feb 20, 2026

@alex-courtis Thanks for the patience with this! It's ready for review.

@Kaiser-Yang

This comment was marked as off-topic.

Kaiser-Yang added a commit to Kaiser-Yang/LightBoat.starter that referenced this pull request Feb 21, 2026
Copy link
Member

@alex-courtis alex-courtis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking good functionally:

  • keymappings work nicely
  • new visual operations work well
  • help and doc are very clear, as are comments on the interfaces

However, the code requires significant rework. There have been far too many changes, refactors that are not necessary and the bulk FS operations are not in the correct class.

This change should be a single, atomic commit that is easy to read and identify the changes.
This change should do exactly one thing: add the 4 visual operations. Refactoring or reworking of unrelated code is encouraged, however not when it is unrelated to or not necessary for a change. Raise a separate, follow up PR.

Please:

@v3ceban v3ceban force-pushed the master branch 4 times, most recently from 0ff2441 to cae607a Compare February 23, 2026 07:49
@v3ceban
Copy link
Contributor Author

v3ceban commented Mar 1, 2026

We are correctly receiving copy/cut messages, however a message is received for every node, which spams the user with prompts.

That is unacceptable UX and users have (correctly) raised issues about similar in the past.

One message is all we can send. It'll have to be a summary like: [NvimTree] 5 nodes added to clipboard.
20260227_140433

c
20260227_140518

I wasn't able to replicate the exact issue you described, but it led me to discover a related problem I hadn't tested — pasting files that already exist at the destination triggered a separate prompt for each file, which is the same kind of prompt spam we wanted to avoid.

To fix this, I updated the Clipboard class to handle paste conflicts in batch. When conflicts are detected, a single prompt offers three options: rename with a suffix (r), overwrite all (y), or skip all (n). If the chosen suffix still conflicts, it re-prompts. I realize this increases the scope of the PR, but I think it's necessary — without it, pasting a visual selection with conflicts would produce the same per-file prompt spam.

Demo: https://asciinema.org/a/ErimWquwpSyKlpE1

@v3ceban
Copy link
Contributor Author

v3ceban commented Mar 1, 2026

This review is partially complete. It is very time consuming and I am limited in time.

No worries, thank you for taking the time to review this in the first place. Appreciate all the feedback. I believe I did address your comments - let me know if anything is still missing, incorrect, or requires a refactor.

@v3ceban v3ceban requested a review from alex-courtis March 1, 2026 03:18
@alex-courtis
Copy link
Member

Thanks for the updates, I'll get to a review shortly.

@alex-courtis
Copy link
Member

alex-courtis commented Mar 5, 2026

To fix this, I updated the Clipboard class to handle paste conflicts in batch. When conflicts are detected, a single prompt offers three options: rename with a suffix (r), overwrite all (y), or skip all (n). If the chosen suffix still conflicts, it re-prompts. I realize this increases the scope of the PR, but I think it's necessary — without it, pasting a visual selection with conflicts would produce the same per-file prompt spam.

That's a good call. Users will be doing more bulk pastes now that visual mode is available and we should harden it, with the skip option quite likely to be used. The rename suffix is a better option than rename.

Copy link
Member

@alex-courtis alex-courtis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great, only a few small changes required.

Please

Preparing for release:

  • You'll be "on call" for this change and will be mentioned in an issue/discussion
  • If there is a breaking issue, we prefer to push a fix fast
    • If that's not safe or achievable, we will have to roll back and redo the change with the fix

@v3ceban
Copy link
Contributor Author

v3ceban commented Mar 5, 2026

@alex-courtis Thanks again for the review! I’ll take a more detailed look and work on addressing the issues and edge cases you raised shortly.

I’m okay with being mentioned in the issues. Will do my best to respond and create PRs with fixes in a timely manner :)

@v3ceban v3ceban force-pushed the master branch 6 times, most recently from 583600a to 31c5df1 Compare March 5, 2026 23:04
@v3ceban v3ceban requested a review from alex-courtis March 5, 2026 23:33
@v3ceban
Copy link
Contributor Author

v3ceban commented Mar 5, 2026

@alex-courtis Ready for re-review (no rush, I know you're busy!)

Changes since last review:

  • Added node_or_nodes:is(Node) class check in all 4 dispatch sites
  • filter_descendant_nodes walks full .parent chain instead of path-prefix matching
  • Sorted mode characters in help display (thx for the nit, I completely missed that!)
  • finish_paste uses reload_explorer() to avoid stale tree after paste (missed this bug initially, it was creating a partially updated tree with pasted files added but not removed visually)
  • Updated PR description to reflect current state

@alex-courtis
Copy link
Member

Thanks for the updates, I'll get to a review shortly.

@alex-courtis alex-courtis changed the title feat(#2994): add visual selection operations feat(#2994): add visual selection operations: copy, cut, delete, trash, toggle bookmark Mar 13, 2026
@alex-courtis alex-courtis changed the title feat(#2994): add visual selection operations: copy, cut, delete, trash, toggle bookmark feat(#2994): add visual mode operations: copy, cut, delete, trash, toggle bookmark Mar 13, 2026
Copy link
Member

@alex-courtis alex-courtis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks for all your incredible work on this most impactful change.

Merging this now. We'll hold any further merges for a few days.

---@param action ClipboardAction
function Clipboard:finish_paste(action)
self.data[action] = {}
self.explorer:reload_explorer()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. That's the safest approach.

@alex-courtis alex-courtis merged commit 9197f3e into nvim-tree:master Mar 13, 2026
5 of 6 checks passed
@alex-courtis
Copy link
Member

This will be released as 1.16.0 once it's settled.

@v3ceban
Copy link
Contributor Author

v3ceban commented Mar 13, 2026

@alex-courtis Thanks again for your time and all the reviews! Happy to see this in master!

v3ceban added a commit to v3ceban/.dotfiles that referenced this pull request Mar 13, 2026
Switched nvim-tree.lua source from custom fork
(v3ceban/nvim-tree.lua) back to the official repository
(nvim-tree/nvim-tree.lua) following the merge of
nvim-tree/nvim-tree.lua#3268.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Visual Selection

5 participants